[Deprecated] Mark External Gateway Invoice As Paid

Deprecated. Please use payment-level external gateway APIs: /merchant/payment/external_gateway_payment/mark_paid. This invoice-level API is kept for compatibility only.

POST /merchant/invoice/external_gateway_invoice/mark_paid

[Deprecated] Mark External Gateway Invoice As Paid

cURL

curl --request POST \
  --url https://api.unibee.dev/merchant/invoice/external_gateway_invoice/mark_paid \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalTransactionId": "<string>",
  "invoiceId": "<string>",
  "signature": "<string>",
  "timestamp": 123,
  "gatewayId": 123,
  "metadata": {},
  "paidTime": 123
}
'

200

{
  "code": 123,
  "data": {
    "invoiceId": "<string>",
    "paymentId": "<string>",
    "status": "<string>",
    "subscriptionId": "<string>"
  },
  "merchantId": 123,
  "message": "<string>",
  "redirect": "<string>",
  "requestId": "<string>"
}

Endpoint Overview

POST https://api.unibee.dev/merchant/invoice/external_gateway_invoice/mark_paid

Deprecated. Please use payment-level external gateway APIs: /merchant/payment/external_gateway_payment/mark_paid. This invoice-level API is kept for compatibility only.

---

Authorization

All UniBee Merchant API requests require authentication via API key.

Header	Required	Description
Authorization	Yes	Bearer <your_api_key>
Content-Type	Yes	application/json (for request body)

---

Parameters

Parameters for this endpoint are listed below. The schema is also shown in the Try it panel.

Request body

Name	Type	Required	Description
externalTransactionId	string	Yes	External payment transaction id from gateway, used as idempotent key
gatewayId	integer	No	Optional. External gateway id; omit to use invoice’s current gateway for auth
invoiceId	string	Yes	Invoice id
metadata	object	No	Additional metadata from external gateway
paidTime	integer	No	Paid time, UTC timestamp in seconds (optional, default now)
signature	string	Yes	HMAC-SHA256(gatewayKey, invoiceId|externalTransactionId|timestamp), hex-encoded
timestamp	integer	Yes	Request timestamp, UTC seconds, used for expiry check

---

Request examples

cURL

curl -X POST "https://api.unibee.dev/merchant/invoice/external_gateway_invoice/mark_paid" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "externalTransactionId": "id_example",
  "gatewayId": 0,
  "invoiceId": "id_example",
  "metadata": {},
  "paidTime": 0,
  "signature": "",
  "timestamp": 0
}'

Sandbox

curl -X POST "https://api-sandbox.unibee.top/merchant/invoice/external_gateway_invoice/mark_paid" \
  -H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "externalTransactionId": "id_example",
  "gatewayId": 0,
  "invoiceId": "id_example",
  "metadata": {},
  "paidTime": 0,
  "signature": "",
  "timestamp": 0
}'

---

Response

Success responses return a JSON envelope with code, data, message, redirect, and requestId. code 0 indicates success.

Field	Type	Description
code	integer	Response code. 0 = success
data	object	Response payload
data.invoiceId	string	Invoice id
data.paymentId	string	Created or reused payment id
data.status	string	Result status, e.g. success
data.subscriptionId	string	Subscription id
message	string	Human-readable message
requestId	string	Request ID for support

---

Error handling

HTTP status	Meaning
400	Bad request — invalid or missing parameters. Check message in the body.
401	Unauthorized — missing or invalid API key.
404	Not found — invalid path or resource.
500	Server error — retry with backoff.

When code in the response body is non-zero, check message for details. Use requestId when contacting support.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Deprecated. Please use payment-level external gateway APIs: /merchant/payment/external_gateway_payment/mark_paid. This invoice-level API is kept for compatibility only.

externalTransactionId · string<string> · required

External payment transaction id from gateway, used as idempotent key

invoiceId · string<string> · required

Invoice id

signature · string<string> · required

HMAC-SHA256(gatewayKey, invoiceId|externalTransactionId|timestamp), hex-encoded

timestamp · integer<int64> · required

Request timestamp, UTC seconds, used for expiry check

gatewayId · integer<int64>

Optional. External gateway id; omit to use invoice's current gateway for auth

metadata · object

Additional metadata from external gateway

Show child attributes

paidTime · integer<int64>

Paid time, UTC timestamp in seconds (optional, default now)

Response

200 - application/json

code · integer<int>

data · object

Show child attributes

merchantId · integer<int64>

message · string<string>

redirect · string<string>

requestId · string<string>